small fix to fontTools Documentation heading #3490
Conversation
|
Changes also made to optional.rst for easy and concise readbility |
| set of keywords that describe a group of additional dependencies, which can be | ||
| used when installing via pip, or when specifying a requirement. | ||
| For example: | ||
| The FontTools PyPI distribution supports "extras", which are groups of additional dependencies that can be installed alongside FontTools via pip to enable specific features. For example: |
There was a problem hiding this comment.
I know that there is already a lack of total consistency in the docs regarding the capitalization of "FontTools" when it is used as the name of the project (versus, for example, referring to the modules). I see that this PR uses "FontTools" here, but uses "fontTools" in index.rst. Might as well be consistent within the PR, IMO.
Personally, I think starting with the capital F is the way to go, both because it more clearly differentiates between "project name" and "token" use cases, but also because of the project logo....
If there are other strong opinions, though, I'm happy to hear what they all are.
|
|
||
| * `fs <https://pypi.org/pypi/fs>`__: (aka ``pyfilesystem2``) filesystem abstraction layer. | ||
| Package for reading and writing UFO source files. Dependencies include: |
There was a problem hiding this comment.
My preference would be to spell out "Unified Font Object (UFO)" here, on first usage at this entry point. It's clear if the reader already knows what UFO is, but you are always going to get people who are diving in without a lot of prior background reading, because they've got some ultra-specific problem they're trying to fix.
There was a problem hiding this comment.
I should maybe add that I don't think it's necessary to always spell out UFO and other abbreviations, but this is intro material, dealing with step-one installation stuff, so I think the need is higher here....
|
|
||
| To display the Unicode character names when dumping the ``cmap`` table | ||
| with ``ttx`` we use the ``unicodedata`` module in the Standard Library. | ||
| Displays Unicode character names when working with the `cmap` table dumps,with `ttx` we use the `unicodedata` module in the Standard Library. |
There was a problem hiding this comment.
There's a space missing between "," and "with". I would also prefer to move towards "FontTools uses the unicodedata [...] over "we use [...]" but that might be a bigger discussion. Certainly it's not wrong to say "FontTools" instead of "we" though. Also, I would drop the "the" before cmap; pretty minor though.
| (macOS platform only). | ||
|
|
||
| *Extra:* ``type1`` | ||
| - `xattr <https://pypi.python.org/pypi/xattr>`__: Python wrapper for extended filesystem attributes, macOS only. |
There was a problem hiding this comment.
Feel free to disagree here, but I always worry about ambiguity when saying "macOS only" or the like unless it's totally spelled out. As in, are we saying that the module can only be installed on macOS? Or just that the xattrs are only found on macOS (different question how you'd be accessing those filesystems on another platform, though).
There was a problem hiding this comment.
(same "only"ness question on the CocoaPen bit below, I suppose, although I think mounting HFS/HFS+ disks is still possible on Linux, so the xattrs stuff might be usable there. I'd certainly be happy to learn for sure)
| It requires one of the following packages in order to solve the so-called | ||
| "minimum weight perfect matching problem in bipartite graphs", or | ||
| the Assignment problem: | ||
| Module for resolving contour or component order between different masters. Requires following packages to solve 'minimum weight perfect matching problem in bipartite graphs': |
There was a problem hiding this comment.
Needs a "the" before "following packages" ... or "one of the"?
There was a problem hiding this comment.
I think that, if the Assignment Problem is well-defined enough to have a name, then it'd be ideal to drop a link about it where the name is mentioned. Wikipedia maybe?
|
|
||
| *Extra:* ``ufo`` | ||
| - `fs <https://pypi.org/pypi/fs>`__: (aka ``pyfilesystem2``) filesystem abstraction layer | ||
| - `enum34 <https://pypi.org/pypi/enum34>`__ backport for the built-in ``enum`` module (module for Python versions < 3.4) |
There was a problem hiding this comment.
I'd cut out the second "module" there.
No description provided.